/*
 * Copyright 2008 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.dopdf.document.request;

import javax.servlet.http.HttpServletRequest;

/**
 * The class that provides an implementation for canProcess method.
 * Base class for all request processors that determin, whether they can process the request or not using a regular
 * expression.
 *
 * @author Deep Shah
 */
public abstract class AbstractRegExBasedRequestProcessor implements RequestProcessor {
    /**
     * {@inheritDoc}
     */
    public final boolean canProcess(final HttpServletRequest request) {
        return request.getRequestURI().matches(getRegEx());
    }

    /**
     * The method that tells which regex patter can be processed by this type of request processors.  All sub-classes
     * should implement this method to return the regex pattern which matches the types of request they can process.
     *
     * @return String representing the regex pattern matching the types of request they can process.
     */
    protected abstract String getRegEx();

}
